Log a warning for uncommitted changes on transaction exit #266
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #266 +/- ##
==========================================
+ Coverage 94.24% 94.32% +0.08%
==========================================
Files 5 5
Lines 382 388 +6
Branches 70 72 +2
==========================================
+ Hits 360 366 +6
Misses 13 13
Partials 9 9 ☔ View full report in Codecov by Sentry. |
nicholasjng
reviewed
Feb 21, 2024
src/lakefs_spec/transaction.py
Outdated
Comment on lines
135
to
138
| if any(True for _ in self._ephemeral_branch.uncommitted()): | ||
| logger.warning( | ||
| f"Transaction closed with uncommitted changes. {'Objects added but not committed are lost.' if self.delete != 'never' else ''}" | ||
| ) |
There was a problem hiding this comment.
Suggested change
| if any(True for _ in self._ephemeral_branch.uncommitted()): | |
| logger.warning( | |
| f"Transaction closed with uncommitted changes. {'Objects added but not committed are lost.' if self.delete != 'never' else ''}" | |
| ) | |
| if any(self._ephemeral_branch.uncommitted()): | |
| msg = f"Finished transaction {self._ephemeral_branch.id!r} contains uncommitted changes." | |
| if self.delete != "never": | |
| msg += " Objects added but not committed are lost." | |
| warnings.warn(msg) |
Explanation: We always prefer a warning over a log, because that works even when the user does not set up logging. If the user needs logging, he can do import logging; logging.capturewarnings(True), if he wants to catch the warnings, he can do so with a warnings filter context manager or by redirecting stderr.
Bonus: We keep a clean separation between stdout and stderr.
maxmynter
force-pushed
the
warning-msg
branch
from
3769e24 to
aae415c
Compare
maxmynter
force-pushed
the
warning-msg
branch
from
aae415c to
c599118
Compare
nicholasjng
approved these changes
Feb 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #264